Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #4403

Merged
merged 4 commits into from
Apr 16, 2024
Merged

Update documentation #4403

merged 4 commits into from
Apr 16, 2024

Conversation

bmribler
Copy link
Contributor

  • Added File Image Operations to Technical Notes
  • Re-fixed a few links for reliability

- Added File Image Operations to Technical Notes
- Fixed a few more link
<p>See the following for more information.</p>
<p>The “RFC: File Image Operations” is the primary source for the information in this document.</p>
<p>The “Alternate File Storage Layouts and Low-level File Drivers” section is in “The HDF5 File” chapter of the HDF5 User’s Guide .</p>
<p>The H5P_SET_FAPL_CORE function call can be used to modify the file access property list so that the Memory virtual file driver, H5FD_ CORE, is used. The Memory file driver is also known as the Core file driver.</p>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

H5FD_ CORE -> H5FD_CORE?


<h3 id="java-signatures-for-file-image-operations-api-calls">5. Java Signatures for File Image Operations API Calls</h3>
<p>Potential Java function call signatures for the file image operation APIs are described in this section. These have not yet been implemented, and there are no immediate plans for implementation.</p>
<p>Note that the H5LTopen_file_image() call is omitted. Our practice has been to not support high-level library calls in Java.</p>
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Our practice has been to not support high-level library calls in Java.

->

We have not supported high-level library calls in Java.

or

Our practice has been to discourage the use of high-level library calls in Java.

@mattjala mattjala added Priority - 2. Medium ⏹ It would be nice to have this in the next release Component - Documentation Doxygen, markdown, etc. Type - Improvement Improvements that don't add a new feature or functionality labels Apr 15, 2024
@@ -608,7 +608,6 @@ on the <a href="http://hdfeos.org/">HDF-EOS Tools and Information Center</a> pag
\section secHDF5Examples Examples
\li \ref LBExamples
\li \ref ExAPI
\li <a href="https://github.com/HDFGroup/hdf5/tree/develop/examples">Examples in the Source Code</a>
Copy link
Contributor

@byrnHDF byrnHDF Apr 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't this be reverted and point to the HDF5Examples source: https://github.com/HDFGroup/hdf5/blob/develop/HDF5Examples

@lrknox
Copy link
Collaborator

lrknox commented Apr 16, 2024

The links beginning with https://hdfgroup.github.io/hdf5/ will, I think, need a branch name, develop, v1_14, etc., in order to pass the Markdown chek links test.

@bmribler
Copy link
Contributor Author

Right, but that file is not in this PR and the change is already made in PR #4409. What is my option here?

@byrnHDF
Copy link
Contributor

byrnHDF commented Apr 16, 2024

Right, but that file is not in this PR and the change is already made in PR #4409. What is my option here?

Do not worry about 4409, I will fix it when this is merged.

@bmribler
Copy link
Contributor Author

bmribler commented Apr 16, 2024

Right, but that file is not in this PR and the change is already made in PR #4409. What is my option here?

Do not worry about 4409, I will fix it when this is merged.

I don't worry about 4409, I worry about the markdown test failure in 4403 because of https://hdfgroup.github.io/hdf5/, which is fixed in 4409. So 4403 cannot be merged until that is fixed. Should I fixed it in this PR?

@byrnHDF
Copy link
Contributor

byrnHDF commented Apr 16, 2024

Sure go ahead and duplicate the fix

@lrknox lrknox merged commit 3f0649c into HDFGroup:develop Apr 16, 2024
57 of 58 checks passed
lrknox pushed a commit to lrknox/hdf5 that referenced this pull request Apr 22, 2024
- Added File Image Operations to Technical Notes

* Use a correct example location
lrknox added a commit that referenced this pull request Apr 25, 2024
* Fixed dead links in docs (#4334)

* Revert "Fixed dead links in docs (#4334)" (#4335)

This reverts commit 408fc66.

* Fix grammar and content in HDF5Examples (#4333)

* Remove HD macros for C time functions (#4337)

* HDasctime
* HDclock
* HDctime
* HDdifftime
* HDgmtime
* HDlocaltime
* HDmktime
* HDtime
* HDtzset

HDgettimeofday will be done later

* Remove HD prefix from toupper/tolower (#4340)

* Add VDS and SWMR to documentation (#4336)

* Clean up random number generator code (#4338)

* Clean up random number generator code

Depending on the platform, we use a mix of random, rand, and rand_r
to generate pseudo-random numbers, along with a messy set of ifdefs
in H5private.h. We are not a cryptographic library, only use random
numbers in our test code, and have no need for anything more than the
C standard's (s)rand(). There's no point dithering about using rand()
vs random() when we're also doing bad things like using mod to
restrict the range, which introduces bias.

Also removes CMake/configure checks for rand_r and random

* Remove random/rand_r checks from build system

* Fix missed HDrandom after GitHub merge

* Remove the getting started guide (#4339)

This was moved to the wiki

* Remove noise comment from H5DO.c (#4342)

* Add note about H5Iregister_type hash_table param (#4345)

The hash_table parameter is unused in HDF5 1.8.13 and later, when we moved from using hash tables to skip lists for storing IDs. The current hash table implementation does not use this parameter.

* Remove `#undef ERR` from H5private.h (#4346)

This is an old work-around that is no longer necessary.

The only place where we defined ERR is in h5import, and that code
has been updated (in this PR) to rename ERR to INVALID_TOKEN.

* Add NAMECHECK_ONLY to macro list in .clang-format (#4343)

This caused H5TS.c functions to be mis-formatted

* Remove HD from last non-win32 C89 functions (#4348)

Removes the HD prefix from the last C89 functions with no special
Windows equilvalent:

* rename
* rewind
* setbuf
* signal
* tmpfile

* Fix dead links cont. (#4349)

Added img/images_to_copy.dox as a temporary solution because doxygen didn't copy
the images used in the examples/*.html files - will investigate more.  This was
necessary for the links to intro_SWMR.html and intro_VDS.html.

* Fix a typo (#4352)

* Fix use of possibly uninitialized memory in h5repack (#4354)

* Match content listing with content. (#4357)

* Remove obsolete c++ doxygen config files (#4358)

* Fix typo VERSIO (#4363)

* Removed duplicate entries in compile line for h5* compiler wrappers (#4360)

* h5fc remove duplicate args
* h5 wrappers remove duplicate args

* Added CVE info to RELEASE.txt (#4367)

* Change doxygen version from 1.10.0 to 1.9.7 (#4371)

* Fix all doxygen versions (#4377)

* Change date to data in INSTALL_parallel (#4384)

* Fix a broken link for zlib url (#4383)

* Fix broken links and references in INSTALL_Auto.txt (#4382)

* Remove  signature in comment (#4366)

* switched from \returns to commonly used \return (#4389)

* Add CXX flags (#4359)

* Remove TRACE macros (#4341)

* Set available CMake build types for non-multi-config generators (#4330)

* Correct the high-level library link (#4398)

* Correct the high-level library link

The link currently used points to 1.13 release.  Changed to use the md file instead.

* Update Doxyfile for md files

* Update to include md files

* Add additional terms to the glossary (#4401)

Fixes GH #4390

* added missing doxygen \since (#4410)

* Update Intel oneAPI version to 2024.1 (#4412)

* Update documentation (#4403)

- Added File Image Operations to Technical Notes

* Use a correct example location

* Use aliases for URLs (#4409)

* Fix CXX sanitizer by moving marco include to after CXX code. (#4414)

* Update and use more URL alias (#4413)

* Update documentation (#4415)

Added the replacement for https://docs.hdfgroup.org/archive/support/HDF5/doc/TechNotes/Version.html
Corrected some minor typos and another deadlink

* Remove obsolete file (#4416)

* Update oneAPI version to 2024.1 for Daily Build (#4418)

* Add training videos page (#4422)

* Updates for release_docs/NEWSLETTER.txt. (#4423)

* Add release process markdown file (#4312)

* Lowercase  in File Format Specification (#4424)

* Fixing string in RELEASE_PROCESS.md that is causing a doxygen error - (#4430)

Unsupported xml/html tag <n> found.

* Allow clang-format to format H5Cpkg.h (#4429)

Co-authored-by: Larry Knox <lrknox@hdfgroup.org>

* Fix broken links in md files needing full URLs.

* Add URL for Java examples that was accidentally dropped.
Change paths from develop to 1.14 directories for some doxygen generated
files.

* Correct typo.

* Fix 2 more dead URLs.

* Revert "Clean up random number generator code (#4338)"

This reverts commit 58e4d08.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Component - Documentation Doxygen, markdown, etc. Priority - 2. Medium ⏹ It would be nice to have this in the next release Type - Improvement Improvements that don't add a new feature or functionality
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants